Syntax Definitions
The following table summarizes the functions available within Engage. Detailed breakdowns with examples are available in each function's dedicated article.
| Function | Category | Summary |
|---|---|---|
|
Maths Function |
Returns the Absolute Value of a number. |
|
|
Cross-table |
Checks the source query against the target query and returns True if any of the records in the source query came after those in the target query. |
|
|
Date Function |
Returns the age in years from the value supplied to the current system date. |
|
|
Date Function |
Returns the age in years from the value supplied in the first argument to the value supplied in the second argument. |
|
|
Date Function |
Returns the date of an anniversary. |
|
|
Date Function |
Returns the number of days to an anniversary. |
|
|
Geographic |
This function will extract the area label from a postcode in standard UK format. |
|
|
Cross-table |
Takes all the child records that match the optional filter query and sums the values for each parent record. Then divides the sum by the number of child records for the parent that match the criteria. |
|
|
Cross-table |
Takes all the child records for each parent that match the optional filter criteria and fall within the specified index and returns the average for each parent record. |
|
|
Cross-table |
Returns a number that represents the average difference between each of a child records of the parent. |
|
|
Objects |
This function will return a number that indicates which element of a band each record falls into. |
|
|
Cross-table |
Takes the child records for each parent and sorts them by the field specified in the fieldName parameter. |
|
|
Campaign Function |
Specialised function to allow querying on standard campaign history and response tables. |
|
|
Text Function |
Turns a delimited list of data values into a categorised data banding. |
|
|
Maths Function |
Returns the value from a numeric field rounded up to the next whole number. |
|
|
Query Domain |
Converts the value supplied into the equivalent ASCII character for that number. |
|
|
Text Function |
Returns the ASCII character code for the first character of the string supplied. |
|
|
Text Function |
Joins several text values together into a single text value. |
|
|
Data Conversion |
Converts one datatype to another. |
|
| COUNT | Cross-table | Returns the number of child records for each parent. The optional filter query restricts the child records to be included in the calculation. |
|
Cross-table |
Returns the number of child records for each parent that match the optional filter criteria, and fall within the specified index. |
|
|
Cross-table |
Returns the number of distinct values in a field on the child table for each parent record. |
|
|
Constants |
Returns the current date and time. |
|
|
Date Function |
Adds a time interval to the input date. |
|
|
Date Function |
Returns just the date part from a value that includes the date and time. |
|
|
Date Function |
Returns the day component of the date supplied. Any leading zeros are removed. |
|
|
Date Function |
Returns the day in a month for the date supplied, from 1 to 31. |
|
|
Date Function |
Returns the day of week component of the date supplied. Any leading zeros are removed. |
|
|
Date Function |
Returns the day of the year for the date supplied. Any leading zeros are removed. |
|
|
Date Function |
Returns the number of whole days between two given dates. |
|
|
Conditions |
Decodes values within a discrete field to an alternative set of values. |
|
|
Geographic |
The geographic field to extract the area section from. |
|
|
Geographic |
This function will extract the district label from a postcode in standard UK format. |
|
|
Maths Function |
Returns e raised to the power of the value in a numeric field. |
|
|
Cross-table |
For each parent record, returns the value from the first child record. The child records are looked at in natural unsorted order. |
|
|
Query Domain |
When used within a query the function produces a recordset that contains only one record for each unique value of the argument. |
|
|
Cross-table |
Flags the first occurrence of a record that meets the criteria supplied in the filterQuery argument. |
|
|
Maths Function |
Returns the value from a numeric field rounded down to the next whole number. |
|
|
Geographic |
The format function allows the output format of a Geographic field to be changed into a number of different formats. |
|
|
Geographic |
A specialised function that selects all the leads within a radius specified in metres of a central geographic point. |
|
|
Geographic |
This function returns the internal area number of standard UK postcode. |
|
|
Geographic |
This function returns the internal area number of a standard UK postcode. |
|
|
Geographic |
Returns the distance, in metres from the OSGB reference point, near the Scilly Isles, due east to a specified postcode. |
|
|
Geographic |
Returns the ISBA TV region as derived from the postcode. |
|
|
Geographic |
Returns the distance, in metres from the OSGB reference point, near the Scilly Isles, due north to a specified postcode. |
|
|
Geographic |
This function returns the internal sector number of a standard UK postcode. |
|
|
Date Function |
This function returns just the hour from a date time field. |
|
|
Conditions |
Checks whether the condition is true or false and returns the value specified in the true argument if the condition is met or in the false argument if it is not. |
|
|
Cross-table |
Returns a number for each child record that indicates its index. |
|
|
Text Function |
Returns the position of the first character that matches the specified string. |
|
| ISNULL | Conditions | Checks the value for a specified field and if the value is NULL it will replace the NULL value with the value supplied in the field name or constant value argument. |
|
Text Function |
Imports data from a key file. |
|
|
Text Function |
Returns field label if present. |
|
|
Maths Function |
Returns the largest value from the supplied values. |
|
|
Cross-table |
Returns the value from the last child record for each parent record. |
|
|
Constants |
Using the table name supplied the function returns a date and time that represents the last time that a delete action was carried out on the specified table. |
|
|
Constants |
Using the table name supplied the function returns the value of the primary key on the last record of the specified table. |
|
|
Constants |
Using the table name supplied the function returns the last date and time that the specified table was subject to an update or append of records. |
|
|
Text Function |
Returns the number of characters specified from the left-hand end of a string. |
|
|
Text Function |
Returns the number of characters in the specified string. |
|
|
Maths Function |
Returns the Natural Logarithm (base 2.71828) for the values in a numeric field. |
|
|
LOG (Log10) |
Maths Function |
Returns the Common Logarithm (base 10) for the values in a numeric field. |
|
Text Function |
Converts all the characters of the specified string into lower case. |
|
|
Cross-table |
For each parent, returns a number that represents the maximum difference between each of the child records. |
|
|
Cross-table |
Returns the maximum value of a field on the child table for each parent record. |
|
|
Cross-table |
Takes all the child records for each parent that match the optional filter criteria and fall within the specified index and returns the maximum for each parent record. |
|
|
Cross-table |
Returns the median value of the child records for each parent record. |
|
|
Cross-table |
For each parent, returns a number that represents the minimum difference between each of the child records. |
|
|
Cross-table |
Returns the minimum value of the field on the child table for each parent record. |
|
|
Cross-table |
Takes all the child records for each parent that match the optional filter criteria and fall within the specified index and returns the minimum for each parent record. |
|
|
Date Function |
This function returns just the minute from a date time field. |
|
|
Cross-table |
Return the most frequent value of a field. |
|
|
Model Function |
A specialised function that selects leads from a model. |
|
|
Date Function |
Returns just the month element of the date supplied. |
|
|
Date Function |
Returns the number of whole months between two given dates. |
|
|
Cross-table |
Allows N records to be selected from a table across a 1 to many join based on the value of a field at the many end. |
|
|
Date Function |
Returns the number of working days between two dates. |
|
|
Query Domain |
This function inverts the recordset that is created by the expression argument. |
|
|
Cross-table |
Flags child records that are after records that meet the criteria given in the source query. |
|
|
Cross-table |
Flags child records that are before records that meet the criteria given in the source query. |
|
|
Cross-table |
Retrieves a sibling value. |
|
|
Query Domain |
When used within a query the function produces a recordset that contains a sample of records. |
|
|
Query Domain |
When used within a query the function produces a recordset that contains one record for each parent record defined by the relationship between the tables. |
|
|
Constants |
Using the table name supplied the function returns a date and time that represents the penultimate time that a delete action was carried out on the specified table. |
|
|
Constants |
Using the table name supplied the function returns the value of the primary key on the last record of the specified table at the time of the penultimate update. |
|
|
Constants |
Using the table name supplied the function returns the penultimate date and time that the specified table was subject to an update or append of records. |
|
|
Maths Function |
Raises the value in a numeric field to a specified power. |
|
|
Text Function |
Uppercases the first letter of each separate word in the specified string. |
|
|
Date Function |
Returns the quarter value (1-4) from a date time field. |
|
|
Maths Function |
Returns a random number between 1 and the value specified. |
|
|
Cross-table |
Returns a number for each child record that indicates its recency. |
|
|
RecordID (_URN) |
Constants |
Returns the Unique Record Number for each record. |
|
Data Conversion |
Returns a new string in which all occurrences of the match string are replaced by the replace string. |
|
|
Text Function |
Returns the number of characters specified from the right hand end of a string. |
|
|
Maths Function |
Rounds the values in a numeric field. |
|
|
Query Domain |
When used within a query the function produces a recordset of only a number of the records from the input recordset. |
|
|
Query Domain |
When used within a query the function produces a recordset of only a percentage of the records from the input recordset. |
|
|
Cross-table |
Returns a number that represents the standard deviation of a parents child records. |
|
|
Cross-table |
Returns a number that represents the standard deviation of a parents child records. However, only the number of records specified by the index parameter will be used. |
|
|
Date Function |
This function returns just the second from a date time field. |
|
|
Geographic |
This function will extract the sector label from a postcode in standard UK format. |
|
|
Maths Function |
Returns -1 for negative values in a field, 0 for zero values and 1 for positive values. |
|
|
Query Domain |
When used within a query the function produces a recordset of the specified number of records. |
|
|
Maths Function |
Returns the smallest value from the supplied values. |
|
|
Text Function |
Soundex is a phonetic algorithm for indexing names by sound, as pronounced in English. |
|
|
Maths Function |
Returns the square root of a value in a numeric field. |
|
|
Maths Function |
Returns the square of a value in a numeric field. |
|
|
Field Statistics |
This function returns the 5th percentile value for every record in a table. |
|
|
Field Statistics |
This function returns the 95th percentile value for every record in a table. |
|
|
Field Statistics |
Returns the same value for every record in a table and allows the resultant summary statistic for a field to be compared against each individual value for the field. |
|
|
Field Statistics |
This function returns the maximum value for every record in a table. |
|
|
Field Statistics |
This function returns the mean value for every record in a table. |
|
|
Field Statistics |
This function returns the median value for every record in a table. |
|
|
Field Statistics |
This function returns the minimum value for every record in a table. |
|
|
Field Statistics |
This function returns the mode value for every record in a table. |
|
|
Field Statistics |
This function returns the record count value for every record in a table. |
|
|
Field Statistics |
This function returns the standard deviation value for every record in a table. |
|
|
Field Statistics |
This function returns the sum value for every record in a table. |
|
|
Text Function |
Removes all spaces from a string. |
|
|
Text Function |
Returns a number of characters from the middle of a string. |
|
| SUM | Cross-table | Returns a number that represents the sum of a parents child records. |
|
Cross-table |
A query string representing the domain of records to include. |
|
|
Query Domain |
The function increases the flexibility of the query language by mimicking the results of rolling a selection. |
|
| TABLERANK | Field Statistics | The Tablerank function returns the rank of each record within a table, based on the specified numeric field. This will allow you to sort and filter your data before ranking it, to calculate and flag the top or bottom records for that value. |
|
Campaign Function |
Function to allow querying of Tags by name or id. |
|
|
Selection Function |
A specialised function that selects leads from tagged data. |
|
|
Date Function |
Returns the time part from a datetime value. |
|
|
Date Function |
Returns a new date value based on adding an interval to the date supplied. |
|
| TIMESTAMPDIFF | Date Function | Calculates the interval between two given dates. The interval timeframe can be changed depending on the fields need. |
|
Query Domain |
When used within a query the function produces a recordset that contains the top or bottom n records based on their values for a given numeric field. |
|
|
Object |
This function is used to return the difference between the band index of the same record on different bands. |
|
|
Text Function |
The function returns the Unicode character for the numeric value supplied. |
|
|
Text Function |
The function returns the Unicode character code for the character value supplied. |
|
|
Text Function |
Uppercases all the characters in the string supplied. |
|
| WEEK | Date Function | Returns the week number of the year (1-52) in which a date falls as a number, allowing transactions to be grouped and reported on by fiscal week number. |
|
Date Function |
Returns the day of the week for the date supplied. |
|
|
Date Function |
Returns the year portion of the date supplied. |
|
| _URN (RecordID) | Constants | Returns the Unique Record Number for each record. |